<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<meta name="GENERATOR" content="PasDoc 0.10.0">
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
<title>Crispy Plotter Documentation: WSVFolder: Class TWSVFolder</title>
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#800080" alink="#FF0000">
<a name="TWSVFolder"></a><h1 class="cio">Class TWSVFolder</h1>
<table class="sections wide_list">
<tr>
<td><a class="section"  href="#@Description">Description</a></td><td><a class="section"  href="#@Hierarchy">Hierarchy</a></td><td><a class="section"  href="#@Fields">Fields</a></td><td><a class="section"  href="#@Methods">Methods</a></td><td><a class="section"  href="#@Properties">Properties</a></td></tr></table>
<a name="@Description"></a><h2 class="unit">Unit</h2>
<p class="unitlink">
<a   href="WSVFolder.html">WSVFolder</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TWSVFolder = class(<a class="normal"  href="WSVFileObject.TWSVFileObject.html">TWSVFileObject</a>)</code></p>
<h2 class="description">Description</h2>
<p>
TWSVFolder establishes a link between a folder and its according tree view node.</p>
<a name="@Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TObject</li>
<li class="ancestor"><a class="normal"  href="WSVObject.TWSVObject.html">TWSVObject</a></li>
<li class="ancestor"><a class="normal"  href="WSVFileObject.TWSVFileObject.html">TWSVFileObject</a></li>
<li class="thisitem">TWSVFolder</li></ul><h2 class="overview">Overview</h2>
<a name="@Fields"></a><h3 class="summary">Fields</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code><b><a   href="WSVFolder.TWSVFolder.html#FFiles">FFiles</a></b>: TObjectList;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code><b><a   href="WSVFolder.TWSVFolder.html#FFolders">FFolders</a></b>: TObjectList;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code><b><a   href="WSVFolder.TWSVFolder.html#FExpanded">FExpanded</a></b>: Boolean;</code></td>
</tr>
</table>
<a name="@Methods"></a><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>procedure <b><a   href="WSVFolder.TWSVFolder.html#CreateFolders">CreateFolders</a></b>(RefreshOnly: Boolean);</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>procedure <b><a   href="WSVFolder.TWSVFolder.html#CreateFiles">CreateFiles</a></b>(RefreshOnly: Boolean);</code></td>
</tr>
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <b><a   href="WSVFolder.TWSVFolder.html#DeleteObjects">DeleteObjects</a></b>: Integer;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <b><a   href="WSVFolder.TWSVFolder.html#GetNodeText">GetNodeText</a></b>(FileName: string): string; override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>class function <b><a   href="WSVFolder.TWSVFolder.html#SubNodeExists">SubNodeExists</a></b>(const List: TObjectList; const Name: string): Boolean;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>procedure <b><a   href="WSVFolder.TWSVFolder.html#AddObject">AddObject</a></b>(const FileClass: <a   href="WSVFileObject.html#TWSVFileClass">TWSVFileClass</a>; const List: TObjectList; const Name: string; const CheckIfExists: Boolean; const TreeNodes: TTreeNodes);</code></td>
</tr>
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>procedure <b><a   href="WSVFolder.TWSVFolder.html#RemoveNonExisting">RemoveNonExisting</a></b>(List: TObjectList);</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>procedure <b><a   href="WSVFolder.TWSVFolder.html#CreateChildren">CreateChildren</a></b>(RefreshOnly: Boolean);</code></td>
</tr>
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>procedure <b><a   href="WSVFolder.TWSVFolder.html#SetExpanded">SetExpanded</a></b>(Value: Boolean);</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>procedure <b><a   href="WSVFolder.TWSVFolder.html#SetImageIndex">SetImageIndex</a></b>; override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <b><a   href="WSVFolder.TWSVFolder.html#CreateSubFileObject">CreateSubFileObject</a></b>(IsFolder: Boolean): Boolean;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a   href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>constructor <b><a   href="WSVFolder.TWSVFolder.html#Create">Create</a></b>(ANode: TTreeNode; FileName: string); override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>destructor <b><a   href="WSVFolder.TWSVFolder.html#Destroy">Destroy</a></b>; override;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a   href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <b><a   href="WSVFolder.TWSVFolder.html#DebugLog">DebugLog</a></b>; override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a   href="WSVFolder.TWSVFolder.html#HasChildren">HasChildren</a></b>: Boolean; override;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a   href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a   href="WSVFolder.TWSVFolder.html#Exists">Exists</a></b>: Boolean; override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a   href="WSVFolder.TWSVFolder.html#FileDeleteNode">FileDeleteNode</a></b>: Boolean; override;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a   href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a   href="WSVFolder.TWSVFolder.html#CreateSubFolder">CreateSubFolder</a></b>: Boolean;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a   href="WSVFolder.TWSVFolder.html#CreateSubFile">CreateSubFile</a></b>: Boolean;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a   href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a   href="WSVFolder.TWSVFolder.html#FindNode">FindNode</a></b>(FilePath: string): <a   href="WSVFileObject.TWSVFileObject.html">TWSVFileObject</a>;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <b><a   href="WSVFolder.TWSVFolder.html#Rebuild">Rebuild</a></b>(AExpanded: Boolean);</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a   href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <b><a   href="WSVFolder.TWSVFolder.html#Refresh">Refresh</a></b>;</code></td>
</tr>
</table>
<a name="@Properties"></a><h3 class="summary">Properties</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a   href="WSVFolder.TWSVFolder.html#Expanded">Expanded</a></b>: Boolean read <a   href="WSVFolder.TWSVFolder.html#FExpanded">FExpanded</a> write <a   href="WSVFolder.TWSVFolder.html#SetExpanded">SetExpanded</a>;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Fields</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="FFiles"></a><code><b>FFiles</b>: TObjectList;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="FFolders"></a><code><b>FFolders</b>: TObjectList;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="FExpanded"></a><code><b>FExpanded</b>: Boolean;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="CreateFolders"></a><code>procedure <b>CreateFolders</b>(RefreshOnly: Boolean);</code></td>
</tr>
<tr><td colspan="2">
<p>
Create children for direct sub folders in this folders</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="CreateFiles"></a><code>procedure <b>CreateFiles</b>(RefreshOnly: Boolean);</code></td>
</tr>
<tr><td colspan="2">
<p>
Create children for files in this folder</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="DeleteObjects"></a><code>function <b>DeleteObjects</b>: Integer;</code></td>
</tr>
<tr><td colspan="2">
<p>
Delete sub items</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="GetNodeText"></a><code>function <b>GetNodeText</b>(FileName: string): string; override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="SubNodeExists"></a><code>class function <b>SubNodeExists</b>(const List: TObjectList; const Name: string): Boolean;</code></td>
</tr>
<tr><td colspan="2">
<p>
Searches for a node with the specified name in a list of WSVFileObject instances.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="AddObject"></a><code>procedure <b>AddObject</b>(const FileClass: <a   href="WSVFileObject.html#TWSVFileClass">TWSVFileClass</a>; const List: TObjectList; const Name: string; const CheckIfExists: Boolean; const TreeNodes: TTreeNodes);</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="RemoveNonExisting"></a><code>procedure <b>RemoveNonExisting</b>(List: TObjectList);</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="CreateChildren"></a><code>procedure <b>CreateChildren</b>(RefreshOnly: Boolean);</code></td>
</tr>
<tr><td colspan="2">
<p>
Create children searches for files and sub folders of this folder. If RefreshOnly is true, then only new children are added and non existing files or folders are removed.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="SetExpanded"></a><code>procedure <b>SetExpanded</b>(Value: Boolean);</code></td>
</tr>
<tr><td colspan="2">
<p>
Expands or collapses the node of the folder in the tree. The folder will only search for sub folders and files, when its node is expanded. When it is collapsed again, its files and sub folders will be removed.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="SetImageIndex"></a><code>procedure <b>SetImageIndex</b>; override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="CreateSubFileObject"></a><code>function <b>CreateSubFileObject</b>(IsFolder: Boolean): Boolean;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>(ANode: TTreeNode; FileName: string); override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Destroy"></a><code>destructor <b>Destroy</b>; override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="DebugLog"></a><code>procedure <b>DebugLog</b>; override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="HasChildren"></a><code>function <b>HasChildren</b>: Boolean; override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Exists"></a><code>function <b>Exists</b>: Boolean; override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="FileDeleteNode"></a><code>function <b>FileDeleteNode</b>: Boolean; override;</code></td>
</tr>
<tr><td colspan="2">
<p>
Deletes the folder and all of its contents in the file system. Calling this method IS DANGEROUS.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="CreateSubFolder"></a><code>function <b>CreateSubFolder</b>: Boolean;</code></td>
</tr>
<tr><td colspan="2">
<p>
Creates a new sub folder in this folder of the file system and adds the appropriate child node to the tree.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="CreateSubFile"></a><code>function <b>CreateSubFile</b>: Boolean;</code></td>
</tr>
<tr><td colspan="2">
<p>
Creates a new file in this folder of the file system and adds the appropriate child node to the tree.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="FindNode"></a><code>function <b>FindNode</b>(FilePath: string): <a   href="WSVFileObject.TWSVFileObject.html">TWSVFileObject</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Find the tree node representing the file specified by FilePath. If the node does not exist, nil is returned.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Rebuild"></a><code>procedure <b>Rebuild</b>(AExpanded: Boolean);</code></td>
</tr>
<tr><td colspan="2">
<p>
Rebuilds the sub folders and files of this folder.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Refresh"></a><code>procedure <b>Refresh</b>;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<h3 class="detail">Properties</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a   href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Expanded"></a><code>property <b>Expanded</b>: Boolean read <a   href="WSVFolder.TWSVFolder.html#FExpanded">FExpanded</a> write <a   href="WSVFolder.TWSVFolder.html#SetExpanded">SetExpanded</a>;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<hr noshade size="1"><span class="appinfo"><em>Generated by <a  target="_parent" href="http://pasdoc.sourceforge.net/">PasDoc 0.10.0</a> on 2007-09-13 21:24:25</em>
</span>
</body></html>
